home *** CD-ROM | disk | FTP | other *** search
/ Aminet 32 / Aminet 32 (1999)(Schatztruhe)[!][Aug 1999].iso / Aminet / dev / c / SUPRALib.lha / SUPRALib / Doku / readme next >
Text File  |  1999-05-17  |  3KB  |  126 lines
  1.  
  2.  Supra -- Additional functions to the existing Amiga libraries
  3.  =====
  4.  
  5.  Version 1.1 (11. Apr 1995)
  6.  © Copyright by Jure Vrhovnik. All rights reserved.
  7.  
  8. You can use Supra library in your own programs. You can redistribute
  9. the original archive as long as it remains unchanged. You may change
  10. the source code but you have to report all changes to the author of
  11. Supra library.
  12.  
  13.  
  14.  
  15. 1) INTRODUCTION
  16. ------------------
  17.  
  18.     Supra is a collection of routines that can be considered as a
  19. small update to Amiga ROM libraries.
  20. Since computer programs grow complexier day by day programmers find
  21. it hard to cope with high level organization, and thus can't afford to
  22. use their time for implementing basic routines. That's why Amiga's
  23. libraries are so valuable - they help programmers to concentrate on
  24. developing larger projects and make the pieces of a puzzle bigger.
  25. However, Amiga libraries haven't been updated for quite a long time.
  26. The pieces of a puzzle haven't changed, but the puzzle grows along with
  27. more advanced projects.
  28.  
  29. This is my first release of supra functions. The collection is very
  30. tiny. However I hope this release will set a decent example that
  31. Amiga OS can and should be updated.
  32.  
  33.  
  34.  
  35. 2) DESCRIPTION
  36. -----------------
  37.  
  38.     Supra is a linked library which contains a few useful functions
  39. that are easy to use. A brief description of what it contains:
  40.  
  41.     o File copier
  42.     o Very easy but powerful recursive directory scanning
  43.     o Quick file type/existance checking
  44.     o Create an entire directory path (extension to CreateDir() )
  45.     o Image colour remapping (now you can show images in their real
  46.       colors on a workbench!)
  47.     o Obtain a list of best pens (extension to ObtainBestPen()
  48.  
  49.  
  50. Here is a list of function names:
  51.  
  52.     - FCopy()
  53.     - FileType()
  54.     - RecDirInit()
  55.     - RecDirNext()
  56.     - RecDirTags()
  57.     - RecDirFree()
  58.     - MakePath()
  59.     - ObtPens()
  60.     - RelPens()
  61.     - MakeNewImg()
  62.     - FreeNewImg()
  63. NEW - AddToolType()
  64.  
  65.  
  66. Every function is well documented and there are some useful examples
  67. included in this archive.
  68.  
  69.  
  70.  
  71. 3) INSTALLATION
  72. -----------------
  73.  
  74.     This release has only a header file for C language. You should
  75. do the following:
  76.  
  77. - copy lib/supra.lib library into your lib: directory
  78. - copy libraries/supra.h header file to include:libraries/supra.h
  79.  
  80.  
  81.  
  82. 4) USAGE
  83. -----------
  84.  
  85.     When you want to use any function from supra library with your
  86. C program you have to include a header file supra.h in your source:
  87.  
  88. #include <libraries/supra.h>
  89.  
  90. You'll have to link your object file with lib:supra.lib
  91.  
  92.  
  93.  
  94. 5) AUTHOR
  95. ------------
  96.  
  97.     I want Supra library to be as perfect as any rom libraries. I
  98. will be very happy for any comments about it (concerning source code,
  99. documentation, new ideas etc.). Programmers who have experiences in
  100. other languages, please contact me if you are willing to make header
  101. files in order to get supra available to other languages as well.
  102.  
  103. My address:
  104.  
  105.     jurev@gea.fer.uni-lj.si
  106.  
  107.     Jure Vrhovnik
  108.     Langusova 13
  109.     Ljubljana, 61000
  110.     Slovenia
  111.  
  112. my URL:
  113.     http://www.fer.uni-lj.si/~jurev
  114.  
  115.  
  116.  
  117. 6) HISTORY
  118. -------------
  119.  
  120.     o v1.1  - Minor problem in source code: no pragmas were included
  121.               (only clib instead of proto). That was causing some problems
  122.               with linking. This is now repaired.
  123.             - AddToolType() function
  124.  
  125.     o v1.0  First release
  126.